Lender Price API Web Service
Lender Price API Web Service / MiCriteria Json Schema
In This Topic
    MiCriteria Json Schema
    In This Topic
    Description
    The MiCriteria object contains fields used in more complex pricing searches.
    Overview
    MiCriteria
    The MiCriteria object contains fields used in more complex pricing searches.
    amortizationType : string

    The amortization type.

    Enum values:

    • FullyAmmortized
    • OptionPayment
    • InterestOnly
    • PotentialNegativeAm

    Example:

    "amortizationType": "fullyAmortized",
    borrowerNonTraditionalCredit : boolean

    If the borrower has non-traditional credit, set to True.

    Default is False.

    borrowerSelfEmployed : boolean

    If the borrower is self-employed, set to True.

    Default is False.

    buyDownPercent : string

    If the borrower intends to buy-down, enter the rate. If the percent is zero, enter "None" or leave empty.

    Values:

    None_1_0_2_1_3_2_1

    • None
    • 1
    • 0
    • 2
    • 3

    Example:

    "buyDownPercent": "None"
    buydownUpfrontAmount : number

    If the borrower intends to buy-down with an upfront amount, enter the fee amount. If the amount is zero, enter 0 or leave empty.

    Example:

    "buydownUpfrontAmount": 0
    coBorrowerFicoScore : integer
    Enter the FICO score of the co-borrower, if there is one.
    coBorrowerNonTraditionalCredit : boolean

    If the co-borrower has non-traditional credit, set to True.

    Default is False.

    coBorrowerSelfEmployed : boolean

    If the co-borrower is self-employed, set to True.

    Default is False.

    companyToken : string
    duLpDecision : string

    The duLp decision. Select one of the enum values.

    Enum Values:

    • DU_Approve_Eligible
    • DU_Approve_Ineligible
    • DU_OutOfScope
    • DU_ReferWith_Caution
    • DU_ReferWith_Caution_IV
    • DU_Refer_Eligible
    • DU_Refer_Ineligible
    • LP_Accept_Eligible
    • LP_Accept_Ineligible
    • LP_Caution_AMinusEligible
    • LP_Caution_Eligible
    • LP_Caution_Ineligible
    initialPremiumAtClosing : string

    Enter the initial premium at closing, if there is one.

     

    loanProgram : string
    Enter the loan program, or leave null.
    loanType : string

    Select the loan type.

    Enum Values:

    • Fixed
    • _1_1
    • _3_1
    • _3_3
    • _5_1
    • _7_1
    • _10_1
    • _15_1

    Default is Fixed.

    miAmortizationType : string

    The amortization type. Same as the amortizationType field. Use the amortizationType field instead of this one.

    Enum Values:

    • FullyAmmortized
    • OptionPayment
    • InterestOnly
    • PotentialNegativeAm
    miCompanyId : string
    Company ID
    miCompanyName : string
    Company name
    miCoverage : number
    miCoverages : Array[number]
    miPremium : number
    miPremiumFinancedIndicator : boolean

    If the premium is financed, set to True.

    Default is False.

    miRateSource : string
    The rate source
    mode : string
    monthlyPlanRefundable : boolean

    If the monthly plan is refundable, set to True.

    Default is False.

    needCoBorrower : boolean

    If the loan requires a co-borrower, set to True.

    Default is False.

    numberOfDeferredPayments : integer
    The number of deferred payments allowed. Default is 0.
    originationChannel : string

    Origination channel of the loan. This field is optional.

    Enum values:

    • Retail
    • WholesaleRetail
    overrideDSCR : number
    overrideDTI : number
    paymentPlan : string

    The name of the payment plan.

    Enum values:

    • EZMonthly
    • SinglePremium
    • None
    paymentType : string

    The type of loan payment, e.g. monthly, annual, or single.

    Enum values:

    • Monthly
    • Annually
    • Single
    premiumRatePlanType : string
    The premium rate plan type.
    rateQuoteAllProductIndicator : boolean
    Default is False.
    rateQuoteProductComparisonIndicator : boolean
    Default is False.
    renewalType : string

    The renewal type.

    Enum values:

    • Constant
    • Amortizing
    • Single
    singlePlanRefundable : boolean
    Default is False.
    useDefaultEstimatedMi : boolean
    varaiableLoanType : string

    The variable loan type, if applicable. Default is null.

    Values: _1_1_2_1_3_1_5_1_5_2_5_5_7_1_7_2_10_1

    Properties
    NameDescriptionData Type

    The amortization type.

    Enum values:

    • FullyAmmortized
    • OptionPayment
    • InterestOnly
    • PotentialNegativeAm

    Example:

    "amortizationType": "fullyAmortized",
    string

    If the borrower has non-traditional credit, set to True.

    Default is False.

    boolean

    If the borrower is self-employed, set to True.

    Default is False.

    boolean

    If the borrower intends to buy-down, enter the rate. If the percent is zero, enter "None" or leave empty.

    Values:

    None_1_0_2_1_3_2_1

    • None
    • 1
    • 0
    • 2
    • 3

    Example:

    "buyDownPercent": "None"
    string

    If the borrower intends to buy-down with an upfront amount, enter the fee amount. If the amount is zero, enter 0 or leave empty.

    Example:

    "buydownUpfrontAmount": 0
    number
    Enter the FICO score of the co-borrower, if there is one.integer

    If the co-borrower has non-traditional credit, set to True.

    Default is False.

    boolean

    If the co-borrower is self-employed, set to True.

    Default is False.

    boolean
     string

    The duLp decision. Select one of the enum values.

    Enum Values:

    • DU_Approve_Eligible
    • DU_Approve_Ineligible
    • DU_OutOfScope
    • DU_ReferWith_Caution
    • DU_ReferWith_Caution_IV
    • DU_Refer_Eligible
    • DU_Refer_Ineligible
    • LP_Accept_Eligible
    • LP_Accept_Ineligible
    • LP_Caution_AMinusEligible
    • LP_Caution_Eligible
    • LP_Caution_Ineligible
    string

    Enter the initial premium at closing, if there is one.

     

    string
    Enter the loan program, or leave null.string

    Select the loan type.

    Enum Values:

    • Fixed
    • _1_1
    • _3_1
    • _3_3
    • _5_1
    • _7_1
    • _10_1
    • _15_1

    Default is Fixed.

    string

    The amortization type. Same as the amortizationType field. Use the amortizationType field instead of this one.

    Enum Values:

    • FullyAmmortized
    • OptionPayment
    • InterestOnly
    • PotentialNegativeAm
    string
    Company IDstring
    Company namestring
     number
     Array[number]
     number

    If the premium is financed, set to True.

    Default is False.

    boolean
    The rate sourcestring
     string

    If the monthly plan is refundable, set to True.

    Default is False.

    boolean

    If the loan requires a co-borrower, set to True.

    Default is False.

    boolean
    The number of deferred payments allowed. Default is 0.integer

    Origination channel of the loan. This field is optional.

    Enum values:

    • Retail
    • WholesaleRetail
    string
     number
     number

    The name of the payment plan.

    Enum values:

    • EZMonthly
    • SinglePremium
    • None
    string

    The type of loan payment, e.g. monthly, annual, or single.

    Enum values:

    • Monthly
    • Annually
    • Single
    string
    The premium rate plan type.string
    Default is False.boolean
    Default is False.boolean

    The renewal type.

    Enum values:

    • Constant
    • Amortizing
    • Single
    string
    Default is False.boolean
     boolean

    The variable loan type, if applicable. Default is null.

    Values: _1_1_2_1_3_1_5_1_5_2_5_5_7_1_7_2_10_1

    string
    See Also